Skip to content

docs: update CLI command for adding GitHub PAT in README - #2527

Merged
SamMorrowDrums merged 2 commits into
mainfrom
rosstarrant/update-claude-cli-in-readme
May 27, 2026
Merged

SamMorrowDrums merged 2 commits into
mainfrom
rosstarrant/update-claude-cli-in-readme

Conversation

@RossTarrant

Copy link
Copy Markdown
Contributor

Summary

Updates the README Claude CLI example for configuring the GitHub MCP Server with a PAT to use the current claude mcp add command.

Why

The README referenced claude mcp update github, but update is not a valid Claude MCP command. This aligns the README with the existing Claude installation guide.

Fixes #2053

What changed

  • Replaced the outdated claude mcp update github example in README.md
  • Updated the example to use claude mcp add github ... -- docker run ...

MCP impact

  • No tool or API changes
  • Tool schema or behavior changed
  • New tool added

Prompts tested (tool changes only)

  • N/A (documentation-only change)

Security / limits

  • No security or limits impact
  • Auth / permissions considered
  • Data exposure, filtering, or token/size limits considered

Tool renaming

  • I am renaming tools as part of this PR (e.g. a part of a consolidation effort)
    • I have added the new tool aliases in deprecated_tool_aliases.go
  • I am not renaming tools as part of this PR

Lint & tests

  • Linted locally with ./script/lint — not run; documentation-only change
  • Tested locally with ./script/test — not run; documentation-only change

Docs

  • Not needed
  • Updated (README / docs / examples)

@RossTarrant
RossTarrant requested a review from a team as a code owner May 22, 2026 15:00
Copilot AI review requested due to automatic review settings May 22, 2026 15:00

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Updates the README’s Claude Code CLI example for configuring the GitHub MCP Server with a GitHub PAT to use the valid claude mcp add command (matching the existing Claude installation guide), fixing the previously documented non-existent claude mcp update usage.

Changes:

  • Replaced the outdated claude mcp update github ... example with claude mcp add github ... -- docker run ... in README.md.
  • Aligned the README command with docs/installation-guides/install-claude.md’s Docker setup instructions.
Show a summary per file
File Description
README.md Fixes the Claude CLI command example for adding the server with a PAT (switches from invalid update to add with Docker invocation).

Copilot's findings

  • Files reviewed: 1/1 changed files
  • Comments generated: 0

@RossTarrant RossTarrant self-assigned this May 26, 2026
@SamMorrowDrums
SamMorrowDrums merged commit f80ca85 into main May 27, 2026
18 checks passed
@SamMorrowDrums
SamMorrowDrums deleted the rosstarrant/update-claude-cli-in-readme branch May 27, 2026 05:39
social4hyq pushed a commit to social4hyq/homebrew-core that referenced this pull request Sep 20, 2026
github-mcp-server 1.1.0

Created-by: HarmonybrewBot
Commit-by: HarmonybrewBot
Merged-by: HarmonybrewBot
Description: Created by `brew bump`

---

Created with `brew bump-formula-pr`.<details>
  <summary>release notes</summary>
  <pre>## Highlights ✨

### Insiders Mode: Issue Fields Support
 
 Issue field support is now available behind the `remote_mcp_issue_fields` feature flag, and is enabled automatically in Insiders Mode. This includes listing issue fields, filtering issues by custom field values, and reading or writing issue field values.
 
 ### Insiders Mode: CSV Output
 
CSV output for default `list_*` tools is now available behind the `csv_output` feature flag, and is enabled automatically in Insiders Mode. CSV provides a flatter, more compact representation for list-style responses, helping to reduce token usage for large result sets.
 
 ### Context Reduction for GitHub Projects
 
 Project item responses have been significantly reduced in size. `list_project_items`, `get_project_item`, and `update_project_item` now return compact project item, content, and field-value shapes instead of full GitHub issue and pull request payloads, cutting unnecessary context while preserving the information agents need.
 
 ### Commit Search
 
 A new `search_commits` tool has been added, allowing agents to search commits directly using GitHub search syntax. This fills a gap between listing repository commits and finding specific commits across debugging, auditing, and release investigation workflows.
 
 ### GHAS Alert Pagination
 
 The GHAS alert listing tools now support pagination. `list_code_scanning_alerts`, `list_dependabot_alerts`, and `list_secret_scanning_alerts` can now retrieve beyond the first page of results, avoiding incomplete alert summaries for repositories with larger security backlogs.
 
 ### Reliability and Hardening
 
 This release includes several tool reliability improvements, including returning `isError` for argument validation failures so agents can self-correct, guarding completions requests against malformed params, and ignoring proxy forwarding headers by default when building OAuth resource metadata.

## What's Changed
* build(deps): bump github.com/google/jsonschema-go from 0.4.2 to 0.4.3 by @dependabot[bot] in github/github-mcp-server#2393
* build(deps): bump actions/attest-build-provenance from 3 to 4 by @dependabot[bot] in github/github-mcp-server#2123
* build(deps): bump actions/setup-node from 4 to 6 by @dependabot[bot] in github/github-mcp-server#2015
* build(deps): bump node from 20-alpine to 26-alpine by @dependabot[bot] in github/github-mcp-server#2013
* build(deps): bump hono from 4.12.0 to 4.12.19 in /ui in the npm_and_yarn group across 1 directory by @dependabot[bot] in github/github-mcp-server#2097
* build(deps): bump ui dependencies to clear security advisories by @SamMorrowDrums in github/github-mcp-server#2493
* build(deps): bump distroless/base-debian12 from `9dce90e` to `58695f4` by @dependabot[bot] in github/github-mcp-server#2497
* build(deps): bump reproducible-containers/buildkit-cache-dance from 3.3.2 to 3.4.0 by @dependabot[bot] in github/github-mcp-server#2500
* build(deps): bump goreleaser/goreleaser-action from 7.2.1 to 7.2.2 by @dependabot[bot] in github/github-mcp-server#2499
* build(deps): bump github.com/modelcontextprotocol/go-sdk from 1.5.1-0.20260403154220-27f29c1cef3b to 1.6.0 by @dependabot[bot] in github/github-mcp-server#2498
* chore(ui): migrate vite 6 → 8, plugin-react 4 → 6; cache UI build in CI by @SamMorrowDrums in github/github-mcp-server#2501
* fix: guard CompletionsHandler against nil params/ref by @SamMorrowDrums in github/github-mcp-server#2502
* fix(ui): advertise get_me as an app via _meta.ui.visibility by @SamMorrowDrums in github/github-mcp-server#2503
* fix(pull_request_read): expose 'after' cursor parameter in input schema by @jluocsa in github/github-mcp-server#2489
* refactor: simplify NewServerTool naming by @SamMorrowDrums in github/github-mcp-server#2510
* fix: return isError for argument validation failures by @SamMorrowDrums in github/github-mcp-server#2511
* refactor: remove dynamic toolsets and deprecated closure constructor by @SamMorrowDrums in github/github-mcp-server#2512
* Adding rationale for fields and labels in issues_granular by @boazreicher in github/github-mcp-server#2505
* Include custom issue field values in list_issues response by @kelsey-myers in github/github-mcp-server#2466
* fix(search_code): tighten query description for accurate model guidance by @SamMorrowDrums in github/github-mcp-server#2513
* Add field_values to search_issues results by @kelsey-myers in github/github-mcp-server#2474
* feat: add pagination to list GHAS alerts tools by @dvirarad in github/github-mcp-server#2451
* feat: Add search commit tool by @Not-Dhananjay-Mishra in github/github-mcp-server#2284
* Fix return Thread node ID in get_review_comments response by @juidesai in github/github-mcp-server#2515
* Add list_issue_fields tool by @kelsey-myers in github/github-mcp-server#2445
* Add custom field filtering to list_issues by @kelsey-myers in github/github-mcp-server#2480
* Remove trailing periods from tool title annotations by @timrogers in github/github-mcp-server#2518
* feat: Add CSV output format for default list tools under insiders mode by @RossTarrant in github/github-mcp-server#2450
* feat(issues): gate issue-fields features behind remote_mcp_issue_fields flag by @SamMorrowDrums in github/github-mcp-server#2520
* chore(gitignore): anchor binary names to repo root by @SamMorrowDrums in github/github-mcp-server#2522
* ci(mcp-diff): build UI artifacts available to baseline checkout by @SamMorrowDrums in github/github-mcp-server#2523
* docs: auto-generate per-flag tool lists for insiders and feature flags by @SamMorrowDrums in github/github-mcp-server#2521
* Adding suggest bool flag to suggest type changes to an issue by @boazreicher in github/github-mcp-server#2548
* Ignore proxy forwarding headers by default for OAuth resource metadata by @SamMorrowDrums in github/github-mcp-server#2550
* docs: update CLI command for adding GitHub PAT in README by @RossTarrant in github/github-mcp-server#2527
* Add support for issue fields values to `issues.read` and `issues.write` by @kelsey-myers in github/github-mcp-server#2551
* Boazreicher/add suggest to labels and issue fields by @boazreicher in github/github-mcp-server#2557
* docs: clarify auth in Codex CLI instructions by @RossTarrant in github/github-mcp-server#2549
* feat: gate issue_write and get_issue behind remote_mcp_issue_fields flag by @SamMorrowDrums in github/github-mcp-server#2558
* Reduce project item response size by @RossTarrant in github/github-mcp-server#2563
* build(deps): bump node from `e71ac5e` to `7c6af15` by @dependabot[bot] in github/github-mcp-server#2540
* build(deps): bump actions/setup-go from 5 to 6 by @dependabot[bot] in github/github-mcp-server#2543
* build(deps): bump docker/metadata-action from 6.0.0 to 6.1.0 by @dependabot[bot] in github/github-mcp-server#2544
* build(deps): bump docker/login-action from 4.1.0 to 4.2.0 by @dependabot[bot] in github/github-mcp-server#2545
* build(deps): bump docker/setup-buildx-action from 4.0.0 to 4.1.0 by @dependabot[bot] in github/github-mcp-server#2546
* build(deps): bump docker/build-push-action from 7.1.0 to 7.2.0 by @dependabot[bot] in github/github-mcp-server#2547
* build(deps): bump github.com/go-chi/chi/v5 from 5.2.5 to 5.3.0 by @dependabot[bot] in github/github-mcp-server#2542

## New Contributors
* @jluocsa made their first contribution in github/github-mcp-server#2489
* @boazreicher made their first contribution in github/github-mcp-server#2505
* @dvirarad made their first contribution in github/github-mcp-server#2451
* @Not-Dhananjay-Mishra made their first contribution in github/github-mcp-server#2284
* @juidesai made their first contribution in github/github-mcp-server#2515
* @timrogers made their first contribution in github/github-mcp-server#2518

**Full Changelog**: https://github.com/github/github-mcp-server/compare/v1.0.5...v1.1.0</pre>
  <p>View the full release notes at <a href="https://github.com/github/github-mcp-server/releases/tag/v1.1.0">https://github.com/github/github-mcp-server/releases/tag/v1.1.0</a>.</p>
</details>
<hr>

See merge request: Harmonybrew/homebrew-core!9289
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation for adding with claude cli is wrong

5 participants